Docs: Update README.md to be more concise and accurate #893
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| - Naked (use your own .img) | ||
| - Naked-Auto (user your own .img and SSH in) | ||
| * `sickcodes/docker-osx:latest`: This is the main image. It allows you to run any version of macOS by setting the `SHORTNAME` environment variable. | ||
| * `sickcodes/docker-osx:auto`: This is a pre-installed version of Catalina. It is useful for quickly getting started with Docker-OSX. |
There was a problem hiding this comment.
FYI, as of 2025-11-24 at least, the docker-osx:auto image seems not to exist
|
|
||
| ## Quick Start Docker-OSX | ||
|
|
||
| Video setup tutorial is also available here: https://www.youtube.com/watch?v=wLezYl77Ll8 |
There was a problem hiding this comment.
While the video is antiquated, it describes the process of deleting and recreating the disk image which is necessary before doing install. Woithout linking the video, the README should describe this process I think
| # docker build -t docker-osx . | ||
| ``` | ||
| * `docker run -it`: This command runs a Docker container in interactive mode. | ||
| * `--device /dev/kvm`: This flag gives the container access to the KVM for hardware acceleration. |
There was a problem hiding this comment.
Are you sure that the GENERATE_UNIQUE=true, and MASTER_PLIST_URL are not needed? I think many users are likley to desire those in an initial setup, and they don't seem to be set in the Dockerfile
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Output: